POST /v1/organizations/:organizationId/mdm/windows/enterprise/policies/

Create winPolicy

Request

Add parameter in header authorization

Example: Authorization: Bearer <token>

organizationId string

required

Entity Id or Slug

Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$

Body Params application/json

name string required

≤ 256 characters

config object optional

applications array [object] optional

winApplicationId string required

Entity Id

Match pattern: ^[a-fA-F0-9]{24}$

configuration object optional

action string optional

forceInstall available

updatePolicy object optional

scripts array [object] optional

type string optional

once loop onDemand

id string optional

≤ 128 characters

loopTime integer optional

≥ 0

resetDate string optional

Format: date-time

arguments string optional

argumentsProcessed string optional

name string optional

≤ 256 characters

description string optional

≤ 500 characters

runner string optional

≤ 256 characters

admxConfigs array [object] optional

winAdmxConfigId string required

Entity Id

Match pattern: ^[a-fA-F0-9]{24}$

assets array [object] optional

mdmAssetId string optional

Entity Id

Match pattern: ^[a-fA-F0-9]{24}$

location string optional

≤ 256 characters

assetName string optional

≤ 256 characters

scope string optional

user system all-users

agentConfiguration object optional

enabled boolean optional

buildTag string optional

≤ 128 characters

allowLocation boolean optional

allowNetworkStatus boolean optional

allowPackageTime boolean optional

allowPackageTransfer boolean optional

{
    "name": "string",
    "config": {},
    "applications": [
        {
            "winApplicationId": "string",
            "configuration": {},
            "action": "forceInstall",
            "updatePolicy": {}
        }
    ],
    "scripts": [
        {
            "type": "once",
            "id": "string",
            "loopTime": 0,
            "resetDate": "2024-01-01T00: 00:00Z",
            "arguments": "string",
            "argumentsProcessed": "string",
            "name": "string",
            "description": "string",
            "runner": "string"
        }
    ],
    "admxConfigs": [
        {
            "winAdmxConfigId": "string"
        }
    ],
    "assets": [
        {
            "mdmAssetId": "string",
            "location": "string",
            "assetName": "string",
            "scope": "user"
        }
    ],
    "agentConfiguration": {
        "enabled": true,
        "buildTag": "string",
        "allowLocation": true,
        "allowNetworkStatus": true,
        "allowPackageTime": true,
        "allowPackageTransfer": true
    }
}

Responses

200 Response application/json

status boolean optional

data object optional

id string optional

Entity Id

Match pattern: ^[a-fA-F0-9]{24}$

organizationId string optional

Entity Id

Match pattern: ^[a-fA-F0-9]{24}$

winEnterpriseId string optional

Entity Id

Match pattern: ^[a-fA-F0-9]{24}$

name string optional

≤ 256 characters

config object optional

applications array [object] optional

winApplicationId string optional

Entity Id

Match pattern: ^[a-fA-F0-9]{24}$

configuration object optional

action string optional

≤ 128 characters

forceInstall available

applicationsInfo array [object] optional

scripts array [object] optional

type string optional

once loop onDemand

id string optional

≤ 128 characters

loopTime integer optional

≥ 0

resetDate string optional

Format: date-time

arguments string optional

argumentsProcessed string optional

name string optional

≤ 256 characters

description string optional

≤ 500 characters

runner string optional

≤ 256 characters

scriptsInfo array [object] optional

admxConfigs array [object] optional

winAdmxConfigId string optional

Entity Id

Match pattern: ^[a-fA-F0-9]{24}$

admxConfigsInfo array [object] optional

id string optional

Entity Id

Match pattern: ^[a-fA-F0-9]{24}$

appName string optional

≤ 256 characters

settingType string optional

≤ 256 characters

fileName string optional

≤ 256 characters

description string optional

≤ 256 characters

agentConfiguration object optional

enabled boolean optional

buildTag string optional

≤ 128 characters

allowLocation boolean optional

allowNetworkStatus boolean optional

allowPackageTime boolean optional

allowPackageTransfer boolean optional

assets array [object] optional

mdmAssetId string optional

Entity Id

Match pattern: ^[a-fA-F0-9]{24}$

location string optional

≤ 256 characters

assetName string optional

≤ 256 characters

scope string optional

user system all-users

assetsInfo array [object] optional

version integer optional

≥ 0

updatedAt string optional

Format: date-time

createdAt string optional

Format: date-time

{
    "status": true,
    "data": {
        "id": "string",
        "organizationId": "string",
        "winEnterpriseId": "string",
        "name": "string",
        "config": {},
        "applications": [
            {
                "winApplicationId": "string",
                "configuration": {},
                "action": "forceInstall"
            }
        ],
        "applicationsInfo": [
            {}
        ],
        "scripts": [
            {
                "type": "once",
                "id": "string",
                "loopTime": 0,
                "resetDate": "2024-01-01T00: 00:00Z",
                "arguments": "string",
                "argumentsProcessed": "string",
                "name": "string",
                "description": "string",
                "runner": "string"
            }
        ],
        "scriptsInfo": [
            {}
        ],
        "admxConfigs": [
            {
                "winAdmxConfigId": "string"
            }
        ],
        "admxConfigsInfo": [
            {
                "id": "string",
                "appName": "string",
                "settingType": "string",
                "fileName": "string",
                "description": "string"
            }
        ],
        "agentConfiguration": {
            "enabled": true,
            "buildTag": "string",
            "allowLocation": true,
            "allowNetworkStatus": true,
            "allowPackageTime": true,
            "allowPackageTransfer": true
        },
        "assets": [
            {
                "mdmAssetId": "string",
                "location": "string",
                "assetName": "string",
                "scope": "user"
            }
        ],
        "assetsInfo": [
            {}
        ],
        "version": 0,
        "updatedAt": "2024-01-01T00: 00:00Z",
        "createdAt": "2024-01-01T00: 00:00Z"
    }
}

401 Response application/json

status boolean optional

false

error object optional

code number optional

4004

message string optional

Invalid Token

{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}

404 Response application/json

status boolean optional

false

error object optional

code number optional

3001

message string optional

Entity not found

{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}